home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Tools / vtcl / doc / CrtInterp.3 < prev    next >
Encoding:
Text File  |  1995-07-10  |  2.8 KB  |  69 lines
  1. '\"
  2. '\" Copyright (c) 1989-1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/CrtInterp.3,v 1.7 93/04/01 09:25:24 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. '\"----------------------------------------------------------------------------
  24. '\"    @(#) CrtInterp.3 26.1 93/10/22 SCOINC
  25. '\"
  26. '\"     Copyright (C) The Santa Cruz Operation, 1992-1993.
  27. '\"     This Module contains Proprietary Information of
  28. '\"    The Santa Cruz Operation, and should be treated as Confidential.
  29. '\"----------------------------------------------------------------------------
  30. .so ../man.macros
  31. .HS Tcl_CreateInterp tclc
  32. .BS
  33. .SH NAME
  34. Tcl_CreateInterp, Tcl_DeleteInterp \- create and delete Tcl command interpreters
  35. .SH SYNOPSIS
  36. .nf
  37. \fB#include <tcl.h>\fR
  38. .sp
  39. Tcl_Interp *
  40. \fBTcl_CreateInterp\fR()
  41. .sp
  42. \fBTcl_DeleteInterp\fR(\fIinterp\fR)
  43. .SH ARGUMENTS
  44. .AS Tcl_Interp *interp
  45. .AP Tcl_Interp *interp in
  46. Token for interpreter to be destroyed.
  47. .BE
  48.  
  49. .SH DESCRIPTION
  50. .PP
  51. \fBTcl_CreateInterp\fR creates a new interpreter structure and returns
  52. a token for it.  The token is required in calls to most other Tcl
  53. procedures, such as \fBTcl_CreateCommand\fR, \fBTcl_Eval\fR, and
  54. \fBTcl_DeleteInterp\fR.
  55. Clients are only allowed to access a few of the fields of
  56. Tcl_Interp structures;  see the Tcl_Interp
  57. and \fBTcl_CreateCommand\fR man pages for details.
  58. The new interpreter is initialized with no defined variables and only
  59. the built-in Tcl commands.  To bind in additional commands, call
  60. \fBTcl_CreateCommand\fR.
  61. .PP
  62. \fBTcl_DeleteInterp\fR destroys a command interpreter and releases all of
  63. the resources associated with it, including variables, procedures,
  64. and application-specific command bindings.  After \fBTcl_DeleteInterp\fR
  65. returns the caller should never again use the \fIinterp\fR token.
  66.  
  67. .SH KEYWORDS
  68. command, create, delete, interpreter
  69.